Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: [DOCS] Add documentation #1

Draft
wants to merge 23 commits into
base: master
Choose a base branch
from
Draft

WIP: [DOCS] Add documentation #1

wants to merge 23 commits into from

Conversation

mr-ubik
Copy link

@mr-ubik mr-ubik commented Aug 26, 2020 •
edited
Loading

  • Document all the Solidity code <3
  • Use solidity-docgen to extract NatSpec as .md files
  • Use mkdocsto generate the docs

@mr-ubik mr-ubik changed the title Docs [DOCS] Add documentation Aug 26, 2020
@mr-ubik mr-ubik added the documentation Improvements or additions to documentation label Aug 26, 2020
@mr-ubik mr-ubik requested review from vasapower and alet89 and removed request for vasapower and alet89 August 26, 2020 16:43
@mr-ubik mr-ubik changed the title [DOCS] Add documentation WIP: [DOCS] Add documentation Aug 29, 2020
@mr-ubik mr-ubik marked this pull request as draft August 29, 2020 17:30
@mr-ubik mr-ubik linked an issue Aug 29, 2020 that may be closed by this pull request
[DOCS] Document all the things! #2
Open
3 tasks
@mr-ubik
Copy link
Author

mr-ubik commented Aug 29, 2020

Even though we are currently using a "working" documentation generation pipeline, it's held together with ducktape and prayers. This PR won't be considered complete until a proper documentation framework is either found or developed.

@mr-ubik mr-ubik self-assigned this Aug 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vasapower vasapower Awaiting requested review from vasapower

Assignees

@mr-ubik mr-ubik

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS] Document all the things!
1 participant
@mr-ubik